<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">		
<html>								
<head>								
	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">	
	<title> $entity</title>	
	<style type="text/css">		
	h1 {							
		font-size:28px;				
		font-family: verdana		
	}								
	p.otherNames{					
		font-size:20px;				
		font-family: verdana;		
	}								
	p.desc {						
		font-size:12px;				
		font-family: verdana;		
	}								
	p.doc {							
		margin-left:2cm;			
	}								
	td.doc {						
		font-size:12px;				
		font-family: verdana;		
		vertical-align:text-top;	
		padding-top: 6px;			
		padding-bottom: 12px;		
	}								
	tr.title {						
		font-family: verdana;		
		font-size:20px;				
		font-weight:bold;			
		background-color: #CCCCFF ;	
	}								
	code.simpledesc {				
		font-size:15px;				
		color: #000099; 			
	}								
	</style>						
</head>							
<body>											
<h1> $entity</h1>	
<p class="otherNames">								Other name(s) : <b>$beanClass</b></p>
<p class="desc">								
Entity class for the current generation <br>
<br>
Provides all information available for an entity as defined in the model : <br>
 . attributes information (class fields) <br>
 . database mapping <br>
<br>
<br>
Since : 2.0.0<br>
</p>		
<table width="100%" border="1" cellspacing="0">		
<TR class="title">										
  <TD>Attributes and methods</TD>			
</TR>		
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.attributes : List of 'attribute' objects</B> </CODE>
<p class="doc">
Returns all the attributes defined for this entity<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.attributes<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.autoincrementedKeyAttribute : 'attribute' object</B> </CODE>
<p class="doc">
Returns the attribute used as the autoincremented key <br>
or null if none<br>
<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.autoincrementedKeyAttribute<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.databaseCatalog : String</B> </CODE>
<p class="doc">
Returns the database catalog of the table mapped with this entity<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.databaseCatalog<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.databaseSchema : String</B> </CODE>
<p class="doc">
Returns the database schema of the table mapped with this entity<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.databaseSchema<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.databaseTable : String</B> </CODE>
<p class="doc">
Returns the database table mapped with this entity<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.databaseTable<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.fullName : String</B> </CODE>
<p class="doc">
Returns the full class name for the entity (ie : "my.package.MyClass" )<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.fullName<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.getAttributesByCriteria(int crit1, int crit2, int crit3, int crit4) : List of 'attribute' objects</B> </CODE>
<p class="doc">
Returns all the attributes of this entity matching the given criteria<br>
This method accepts 1 to 4 criteria<br>
The critera are combined using the 'AND' operator<br>
Usable criteria ( to be prefixed with '$const.' ) : <br>
KEY,  NOT_KEY,  IN_LINKS,  NOT_IN_LINKS,  IN_SELECTED_LINKS,  NOT_IN_SELECTED_LINKS,  TEXT,  NOT_TEXT  <br>
<br>
<b>Parameters : </b><br>
&nbsp;&nbsp;&nbsp;<b>crit1</b> : 1st criterion<br>
&nbsp;&nbsp;&nbsp;<b>crit2</b> : 2nd criterion (optional)<br>
&nbsp;&nbsp;&nbsp;<b>crit3</b> : 3rd criterion (optional)<br>
&nbsp;&nbsp;&nbsp;<b>crit4</b> : 4th criterion (optional)<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.getAttributesByCriteria($const.NOT_KEY)<br>
&nbsp;&nbsp;&nbsp;$entity.getAttributesByCriteria($const.NOT_KEY, $const.NOT_IN_SELECTED_LINKS)<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.hasAutoIncrementedKey() : boolean</B> </CODE>
<p class="doc">
Returns TRUE if this entity has an 'auto-incremented' key attribute <br>
( a key based on a numeric value incremented by the database )<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#if ( $entity.hasAutoIncrementedKey() )<br>
&nbsp;&nbsp;&nbsp;...<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.hasCompositePrimaryKey() : boolean</B> </CODE>
<p class="doc">
Returns TRUE if this entity has a composite primary key <br>
( a primary key composed of 2 or more attributes )<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#if ( $entity.hasCompositePrimaryKey() )<br>
&nbsp;&nbsp;&nbsp;...<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.hasTextAttribute() : boolean</B> </CODE>
<p class="doc">
Returns TRUE if this entity has at least one attribute tagged as 'long text'<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#if ( $entity.hasTextAttribute() )<br>
&nbsp;&nbsp;&nbsp;...<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.imports : List of 'String'</B> </CODE>
<p class="doc">
Returns a list of all the Java imports required for all the fields of the current entity<br>
For example, 'java.util.Date' if the entity uses Date objects, etc...<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#foreach( $import in $entity.imports )<br>
&nbsp;&nbsp;&nbsp;import $import;<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.importsForKeyFields : List of 'String'</B> </CODE>
<p class="doc">
Returns a list of all the Java imports required for the KEY fields of the current entity<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#foreach( $import in $entity.importsForKeyFields )<br>
&nbsp;&nbsp;&nbsp;import $import;<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.importsJpa : List of 'String'</B> </CODE>
<p class="doc">
Returns a list of all the Java JPA imports required by the current entity<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#foreach( $import in $entity.importsJpa )<br>
&nbsp;&nbsp;&nbsp;import $import;<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.jpaAnnotations : String</B> </CODE>
<p class="doc">
Returns a multiline String containing all the Java JPA annotations required for the current entity<br>
without left marging before each line<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.jpaAnnotations<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.jpaAnnotations(int leftMargin) : String</B> </CODE>
<p class="doc">
Returns a multiline String containing all the Java JPA annotations required for the current entity<br>
with the given left marging before each line<br>
<br>
<b>Parameters : </b><br>
&nbsp;&nbsp;&nbsp;<b>leftMargin</b> : number of blanks for the left margin<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.jpaAnnotations(4)<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.keyAttributes : List of 'attribute' objects</B> </CODE>
<p class="doc">
Returns the attributes used in the Primary Key for this entity<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#foreach( $attribute in $entity.keyAttributes )<br>
&nbsp;&nbsp;&nbsp;...<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.links : List of 'link' objects</B> </CODE>
<p class="doc">
Returns a list of all the links defined for the current entity<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#foreach( $link in $entity.links )<br>
&nbsp;&nbsp;&nbsp;...<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.name : String</B> </CODE>
<p class="doc">
Returns the class name for the entity without the package ( ie : "MyClass" )<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.name<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.nonKeyAttributes : List of 'attribute' objects</B> </CODE>
<p class="doc">
Returns the attributes NOT used in the Primary Key for this entity<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#foreach( $attribute in $entity.nonKeyAttributes )<br>
&nbsp;&nbsp;&nbsp;...<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.nonTextAttributes : List of 'attribute' objects</B> </CODE>
<p class="doc">
Returns the attributes NOT tagged as 'long text' for this entity<br>
( 'standard attributes' )<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#foreach( $attribute in $entity.nonTextAttributes )<br>
&nbsp;&nbsp;&nbsp;...<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.package : String</B> </CODE>
<p class="doc">
Returns the package name (or void) for the entity ( ie : "my.package" or "" )<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.package<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.selectedLinks : List of 'link' objects</B> </CODE>
<p class="doc">
Returns a list of all the links selected in the model for the current entity<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#foreach( $link in $entity.selectedLinks )<br>
&nbsp;&nbsp;&nbsp;...<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.sqlKeyColumns : String</B> </CODE>
<p class="doc">
Returns a String containing all the columns of the Primary Key<br>
The returned column names are separated by a comma and have quotes characters<br>
i.e. : '"code", "type"' <br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;String KEY_COLUMNS[] = { $entity.sqlKeyColumns };<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.sqlNonKeyColumns : String</B> </CODE>
<p class="doc">
Returns a String containing all the columns not used in the Primary Key <br>
The returned column names are separated by a comma and have quotes characters<br>
i.e. : '"code", "type"' <br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;String DATA_COLUMNS[] = { $entity.sqlNonKeyColumns };<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.sqlTable : String</B> </CODE>
<p class="doc">
<b>Deprecated.</b><br>
<br>
Returns the database table mapped with this entity<br>
DEPRECATED : use 'databaseTable' instead <br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.sqlTable<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.superClass : String</B> </CODE>
<p class="doc">
Returns the super class for the entity's class (or void if none)<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.superClass<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.textAttributes : List of 'attribute' objects</B> </CODE>
<p class="doc">
Returns the attributes tagged as 'long text' for this entity<br>
( specific attributes used to store long text )<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;#foreach( $attribute in $entity.textAttributes )<br>
&nbsp;&nbsp;&nbsp;...<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.toStringInstruction : String</B> </CODE>
<p class="doc">
<b>Deprecated.</b><br>
<br>
Returns the Java line instruction for the toString() method<br>
DEPRECATED : use 'toStringMethodCodeLines()' instead <br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.toStringInstruction<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.toStringMethodCodeLines(int leftMargin) : String</B> </CODE>
<p class="doc">
Returns a multiline String containing all the Java instructions for the 'toString' method<br>
Argument : number of spaces for the left margin <br>
<br>
<br>
<b>Parameters : </b><br>
&nbsp;&nbsp;&nbsp;<b>leftMargin</b> : number of blanks for the left margin<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.toStringMethodCodeLines(4)<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.toStringMethodCodeLinesWithKey(int leftMargin, List attributes, String keyVarName) : String</B> </CODE>
<p class="doc">
Returns a multiline String containing all the Java instructions for the 'toString' method<br>
The primary key (composite or not) and given list of attributes are used<br>
<br>
<b>Parameters : </b><br>
&nbsp;&nbsp;&nbsp;<b>leftMargin</b> : number of blanks for the left margin<br>
&nbsp;&nbsp;&nbsp;<b>attributes</b> : specific list of attributes to be used in the 'toString' method (except key attributes)<br>
&nbsp;&nbsp;&nbsp;<b>keyVarName</b> : variable name for the composite primary key embedded id (if any)<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.toStringMethodCodeLinesWithKey(8, $attributes, "compositePrimaryKey" )<br>
</code>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.toStringMethodCodeLinesWithKey(int leftMargin, String keyVarName) : String</B> </CODE>
<p class="doc">
Returns a multiline String containing all the Java instructions for the 'toString' method<br>
The primary key (composite or not) and all the 'non key' attributes are used<br>
<br>
<b>Parameters : </b><br>
&nbsp;&nbsp;&nbsp;<b>leftMargin</b> : number of blanks for the left margin<br>
&nbsp;&nbsp;&nbsp;<b>keyVarName</b> : variable name for the composite primary key embedded id (if any)<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;$entity.toStringMethodCodeLinesWithKey(8, "compositePrimaryKey" )<br>
</code>
</p>
</TD>
</TR>
</table>
</body>
</html>
